home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / X11 / xpostit.z / xpostit
Text File  |  1998-10-30  |  17KB  |  397 lines

  1.  
  2.  
  3.  
  4.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           xpostit - X window system Post-it notes
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           xxxxppppoooossssttttiiiitttt [ -_t_o_o_l_k_i_t_o_p_t_i_o_n_s ... ] [ -_o_p_t_i_o_n_s ... ]
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.           _X_p_o_s_t_i_t provides a mechanism for manipulating on-screen
  16.           Post-itr notes.  All six sizes of Post-it notes may be
  17.           displayed, edited, and saved to disk files.  In addition,
  18.           any on-screen note may be resized to any arbitrary size
  19.           either when it is created or at a later time.
  20.  
  21.           When _x_p_o_s_t_i_t is first invoked, it creates a small window
  22.           with a plaid background.  This is the control window for
  23.           _x_p_o_s_t_i_t.  Additionally, if any notes were stored in the save
  24.           directory (see below), these will be placed on the screen at
  25.           their last locations.  Each Post-it note, when created,
  26.           makes another window on the screen.  _X_p_o_s_t_i_t is controlled
  27.           using the mouse buttons and a menu.  The Post-it notes are
  28.           controlled using buttons (Command widgets).
  29.  
  30.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  31.           _X_p_o_s_t_i_t accepts all of the standard X Toolkit command line
  32.           options along with the additional options listed below.
  33.  
  34.           ----bbbbssss _n_u_m_b_e_r
  35.                   Specifies the size of the character buffer in which
  36.                   to save each Post-it note.  A note may not contain
  37.                   more than this number of characters, including
  38.                   newlines.  The default is 1024.
  39.  
  40.           ----ddddiiiirrrr _p_a_t_h
  41.                   Specifies the path name of the directory in which to
  42.                   store saved Post-it notes.  If _p_a_t_h begins with a
  43.                   `/' it is taken as-is; if it does not begin with a
  44.                   `/', the path is taken relative to the home
  45.                   directory.  The named directory must already exist
  46.                   if notes are to be saved in it.  The default is
  47.                   ._p_o_s_t_i_t_n_o_t_e_s.
  48.  
  49.           ----ssssbbbb     Enables scroll-bars.  If specified, a scroll bar
  50.                   will be attached to each Post-it note.
  51.  
  52.           ----ssssvvvv     Enables save-on-exit.  When specified, this option
  53.                   tells _x_p_o_s_t_i_t to save all Post-it notes to disk
  54.                   files when exiting.  If not specified, notes will
  55.                   only be saved to disk files when saved manually by
  56.                   the user.
  57.  
  58.      WWWWIIIIDDDDGGGGEEEETTTT UUUUSSSSAAAAGGGGEEEE
  59.           _X_p_o_s_t_i_t uses several widget types to construct the objects
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  71.  
  72.  
  73.  
  74.           it uses.
  75.  
  76.           The control window is a Plaid widget called ``Plaid''.
  77.  
  78.           The menu is a pop-up shell called ``Menu'' containing a
  79.           SimpleMenu widget.
  80.  
  81.           Each Post-it note is a pop-up shell called ``PostItNote'',
  82.           containing a Form widget called ``Note'' which contains a
  83.           Text widget called ``NoteText'', and four Command widgets
  84.           called ``Save'', ``Erase'', ``Destroy'', and ``Title''.
  85.  
  86.           The confirmation box is a pop-up shell called ``Confirm'',
  87.           containing a Form widget called ``Buttons'' which contains
  88.           two Command widgets called ``Confirm'' and ``Cancel''.  The
  89.           title-change box is a pop-up shell called ``Title'',
  90.           containing a Dialog widget called ``Dialog''.
  91.  
  92.      RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  93.           _X_p_o_s_t_i_t understands all of the core X Toolkit resource names
  94.           and classes as well as those listed below, which are all of
  95.           class XXXXPPPPoooossssttttiiiitttt.
  96.  
  97.           ....bbbbuuuuffffSSSSiiiizzzzeeee
  98.                   Specifies the size of the character buffer used to
  99.                   store a Post-it note.  The default is 1024.
  100.  
  101.           ....nnnnooootttteeeeDDDDiiiirrrr
  102.                   Specifies the path name of the directory in which to
  103.                   store saved notes.  The default is ._p_o_s_t_i_t_n_o_t_e_s.
  104.  
  105.           ....ssssaaaavvvveeeeNNNNooootttteeeessss
  106.                   Controls the state of the save-on-exit option.  The
  107.                   default is ffffaaaallllsssseeee.
  108.  
  109.           ....ssssccccrrrroooollllllllBBBBaaaarrrr
  110.                   Controls placing scroll bars on Post-it notes.  The
  111.                   default is ffffaaaallllsssseeee.
  112.  
  113.      AAAACCCCTTTTIIIIOOOONNNNSSSS
  114.           It is possible to rebind the mouse buttons in the Plaid
  115.           widget to perform different functions by changing the
  116.           widget's translations.  The _r_a_i_s_e() action, normally bound
  117.           to the left mouse button, raises all notes.  The _l_o_w_e_r()
  118.           action, normally bound to the middle mouse button, lowers
  119.           all notes.  The _s_h_o_w() action, normally bound to the middle
  120.           mouse button with the CTRL key, maps all unmapped notes.
  121.           The _h_i_d_e() action, normally bound to the left mouse button
  122.           with the CTRL key, unmaps all notes on the screen.  The menu
  123.           raising function, normally bound to the right mouse button,
  124.           is performed by calling the actions
  125.           _X_a_w_P_o_s_i_t_i_o_n_S_i_m_p_l_e_M_e_n_u(_M_e_n_u) and _M_e_n_u_P_o_p_u_p(_M_e_n_u).  The _q_u_i_t()
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  137.  
  138.  
  139.  
  140.           action, bound to the ``q'' and ``Q'' keys, is equivalent to
  141.           selecting ``Exit'' from the menu.
  142.  
  143.      TTTTHHHHEEEE CCCCOOOONNNNTTTTRRRROOOOLLLL WWWWIIIINNNNDDDDOOOOWWWW
  144.           _X_p_o_s_t_i_t allows six operations to be performed from its
  145.           control window.  Pressing the left mouse button in the
  146.           control window will cause all Post-it notes on the screen to
  147.           be raised to the top.  Pressing the middle mouse button in
  148.           the control window will cause all Post-it notes on the
  149.           screen to be lowered to the bottom.  Pressing the left mouse
  150.           button in the control window while holding down the CTRL key
  151.           will cause all notes to be mapped (shown).  Pressing the
  152.           middle mouse button in the control window while holding down
  153.           the CTRL key will cause all notes on the screen to be
  154.           unmapped (hidden).  Pressing the right mouse button in the
  155.           control window raises the _x_p_o_s_t_i_t menu.  Pressing the ``q''
  156.           or ``Q'' keys in the control window will exit the program.
  157.  
  158.      TTTTHHHHEEEE MMMMEEEENNNNUUUU
  159.           The _x_p_o_s_t_i_t menu provides the following selections:
  160.  
  161.           CCCCrrrreeeeaaaatttteeee 1111....5555xxxx2222 NNNNooootttteeee
  162.                   Create a new Post-it note, 1.5 inches tall by 2
  163.                   inches wide.  The window will normally need to be
  164.                   positioned using the window manager.
  165.  
  166.           CCCCrrrreeeeaaaatttteeee 2222xxxx3333 NNNNooootttteeee
  167.                   Create a new Post-it note, 2 inches tall by 3 inches
  168.                   wide.
  169.  
  170.           CCCCrrrreeeeaaaatttteeee 3333xxxx3333 NNNNooootttteeee
  171.                   Create a new Post-it note, 3 inches square.
  172.  
  173.           CCCCrrrreeeeaaaatttteeee 3333xxxx4444 NNNNooootttteeee
  174.                   Create a new Post-it note, 3 inches tall by 4 inches
  175.                   wide.
  176.  
  177.           CCCCrrrreeeeaaaatttteeee 3333xxxx5555 NNNNooootttteeee
  178.                   Create a new Post-it note, 3 inches tall by 5 inches
  179.                   wide.
  180.  
  181.           CCCCrrrreeeeaaaatttteeee 4444xxxx6666 NNNNooootttteeee
  182.                   Create a new Post-it note, 4 inches tall by 6 inches
  183.                   wide.
  184.  
  185.           RRRRaaaaiiiisssseeee AAAAllllllll NNNNooootttteeeessss
  186.                   Raise all Post-it notes to the top.  This is
  187.                   equivalent to pressing the left mouse button in the
  188.                   control window.
  189.  
  190.           LLLLoooowwwweeeerrrr AAAAllllllll NNNNooootttteeeessss
  191.                   Lower all Post-it notes to the bottom.  This is
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  203.  
  204.  
  205.  
  206.                   equivalent to pressing the middle mouse button in
  207.                   the control window.
  208.  
  209.           HHHHiiiiddddeeee AAAAllllllll NNNNooootttteeeessss
  210.                   Unmap all Post-it notes, making them disappear from
  211.                   the screen.  This is equivalent to pressing the
  212.                   middle mouse button in the control window while
  213.                   holding down the CTRL key.
  214.  
  215.           SSSShhhhoooowwww AAAAllllllll NNNNooootttteeeessss
  216.                   Map all Post-it notes, making them reappear if they
  217.                   were hidden.  This is equivalent to pressing the
  218.                   left mouse button in the control window while
  219.                   holding down the CTRL key.
  220.  
  221.           SSSSaaaavvvveeee AAAAllllllll NNNNooootttteeeessss
  222.                   Save all Post-it notes to disk files in the save
  223.                   directory.
  224.  
  225.           EEEExxxxiiiitttt    Exit _x_p_o_s_t_i_t . If the ----ssssvvvv command line option was
  226.                   given, or the ssssaaaavvvveeeeNNNNooootttteeeessss resource is ttttrrrruuuueeee ,,,, all
  227.                   Post-it notes will be saved to disk first.
  228.  
  229.           To select an item from the menu, drag the mouse cursor to
  230.           that item and release the mouse button.
  231.  
  232.      TTTTHHHHEEEE PPPPOOOOSSSSTTTT----IIIITTTT NNNNOOOOTTTTEEEE
  233.           Each Post-it note is made up of five parts (plus an optional
  234.           scroll bar):  a text window where the text of the note is
  235.           stored, and four buttons labeled ``Save'', ``Erase'',
  236.           ``Destroy'', and ``Title''.
  237.  
  238.           The title of a Post-it note, which will be displayed by most
  239.           window managers in both a title bar and the icon name area,
  240.           is by default the string ``PostItNote #'' followed by a
  241.           small integer, the number of the note.  The procedure for
  242.           changing this title to something more meaningful is
  243.           described below.
  244.  
  245.           To enter text into a Post-it note, simply move the mouse
  246.           cursor into the text window and start typing.  Since the
  247.           text window is actually a Text widget, all the Text widget
  248.           translations are accepted.  Essentially, this means you can
  249.           use most of the EMACS control keys in the window.
  250.           Additionally, the various mouse buttons used for
  251.           manipulating the selections and cut buffer are understood.
  252.  
  253.           After entering text in the Post-it note, you may wish to
  254.           save the note in a disk file.  This way, if the machine goes
  255.           down, or if you exit _x_p_o_s_t_i_t, the Post-it note can be
  256.           restored when you restart _x_p_o_s_t_i_t.  (Post-it notes are also
  257.           saved automatically (if ssssaaaavvvveeeeNNNNooootttteeeessss is true) if a SIGHUP,
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  269.  
  270.  
  271.  
  272.           SIGINT, SIGTERM, or SIGQUIT signal is received.)  To save
  273.           the note to a disk file, move the mouse cursor to the button
  274.           labeled ``Save'' and press the left mouse button.  The note
  275.           will be saved as the file ``note_n'' in your save directory,
  276.           where _n is some sequence number.  NNNNOOOOTTTTEEEE:  it is important to
  277.           remember that until you have pressed the ``Save'' button,
  278.           the data stored in the Post-it note is not saved on disk and
  279.           can be lost if the system goes down or _x_p_o_s_t_i_t exits.
  280.  
  281.           To erase the entire contents of the text window, you can
  282.           press the left mouse button in the ``Erase'' button.  This
  283.           will bring up a confirmation window, which has two buttons
  284.           labeled ``Confirm'' and ``Cancel''.  If you press the
  285.           ``Confirm'' button, the text will be erased.  If you press
  286.           the ``Cancel'' button, the operation is canceled, and
  287.           nothing will happen.  NNNNOOOOTTTTEEEE:  erasing the text in the window
  288.           does not affect any contents of the note you have saved on
  289.           disk unless you press the ``Save'' button again.
  290.  
  291.           To destroy a Post-it note, getting rid of its window on the
  292.           screen and the disk file it is saved in, move the mouse
  293.           cursor to the ``Destroy'' button and press the left mouse
  294.           button.  This will bring up a confirmation window as
  295.           described above.  If you confirm the operation, the Post-it
  296.           note will disappear from the screen and the disk file it was
  297.           saved in will be deleted.
  298.  
  299.           To change the title of a Post-it note, both in any title bar
  300.           on the window as well as in the icon for the note, move the
  301.           mouse cursor to the ``Title'' button and press the left
  302.           mouse button.  This will bring up a dialog box with the
  303.           current title in it.  Change or modify the title, and press
  304.           the ``Okay'' button with the mouse to change the title, or
  305.           press the ``Cancel'' button to discard the change.
  306.  
  307.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  308.           X(1)
  309.  
  310.      BBBBUUUUGGGGSSSS
  311.           The sizes of the Post-it notes are only as accurate as the
  312.           display dimension and resolution returned by the server.  On
  313.           the Sun server and possibly others, this means they aren't
  314.           all that accurate.
  315.  
  316.           When the title of a Post-it note is changed, some window
  317.           managers (notably _t_w_m ) will not make the change in the icon
  318.           name, since they only look up this data when a window is
  319.           mapped.  This can be ``fixed'' by unmapping all notes and
  320.           mapping them again.
  321.  
  322.           Without a color display for canary yellow notes and red
  323.           plaid, the aesthetic value of _x_p_o_s_t_i_t cannot be fully
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))           XXXX11111111RRRR5555 ((((SSSSeeeepppptttteeeemmmmbbbbeeeerrrr 1111999999991111))))            XXXXPPPPOOOOSSSSTTTTIIIITTTT((((1111))))
  335.  
  336.  
  337.  
  338.           appreciated.
  339.  
  340.      AAAAUUUUTTTTHHHHOOOORRRR
  341.           David A. Curry, Purdue University
  342.  
  343.           ``Post-it'' and the plaid design are registered trademarks
  344.           of 3M.
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/30/98)
  394.  
  395.  
  396.  
  397.